Skip to content

Docs: Enhance Contributing section with detailed guidelines and workflow#73

Open
nsrawat0333 wants to merge 1 commit intocode100x:mainfrom
nsrawat0333:docs/improve-contributing-section
Open

Docs: Enhance Contributing section with detailed guidelines and workflow#73
nsrawat0333 wants to merge 1 commit intocode100x:mainfrom
nsrawat0333:docs/improve-contributing-section

Conversation

@nsrawat0333
Copy link

📝 Description

This PR enhances the Contributing section in the README to make it more beginner-friendly and comprehensive for new contributors.

✨ Changes Made

  • ✅ Expanded the contributing section with detailed step-by-step instructions
  • ✅ Added contribution guidelines and best practices
  • ✅ Included clear git workflow commands for contributors
  • ✅ Added link to development setup section for easy reference
  • ✅ Improved formatting and readability

🎯 Why This Change?

The previous contributing section was too brief. New contributors need clear guidance on:

  • How to fork and clone the repository
  • Proper branch naming conventions
  • Testing requirements before submitting PRs
  • Code style and commit message guidelines

📸 Preview

The new Contributing section now includes:

  1. Detailed workflow (8 steps instead of 5)
  2. Contribution Guidelines subsection
  3. Reference to Development Setup
  4. Better formatting with bold headings and code blocks

✅ Checklist

  • Documentation updated
  • Changes are clear and easy to follow
  • No breaking changes
  • Tested locally (README renders correctly)

📌 Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Code refactoring

Note: This is a documentation-only change with no impact on the codebase functionality.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant